Add dataset keywords model #219
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lucaspar
added
feature
lucaspar
requested changes
Nov 12, 2025
Closed
LLKruczek
force-pushed
the
add-dataset-keywords-model
branch
2 times, most recently
from
2b17bdf to
35c9ef5
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a new Keyword model to enable searchable, reusable keywords for datasets, replacing the previous TextField-based approach with a proper many-to-many relationship. The implementation includes autocomplete functionality for better user experience and proper query optimization.
Key changes:
- Introduces a new
Keywordmodel with ManyToMany relationship toDataset, using a customKeywordNameFieldthat auto-slugifies keyword names - Adds keyword autocomplete API endpoint with frontend JavaScript implementation for real-time suggestions
- Migrates logging from standard
loggingmodule tologuruthroughout the views
Reviewed changes
Copilot reviewed 16 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| gateway/sds_gateway/api_methods/models.py | Added Keyword model with custom KeywordNameField for auto-slugification; removed keywords TextField from Dataset model |
| gateway/sds_gateway/api_methods/tests/factories.py | Added post-generation hook for creating Keyword instances in DatasetFactory |
| gateway/sds_gateway/api_methods/serializers/dataset_serializers.py | Added keywords field to DatasetGetSerializer to return keyword names |
| gateway/sds_gateway/api_methods/admin.py | Registered Keyword model in admin and added keyword display to DatasetAdmin |
| gateway/sds_gateway/users/views.py | Added KeywordAutocompleteAPIView; updated dataset create/update logic to handle keyword associations; migrated from logging to loguru |
| gateway/sds_gateway/users/urls.py | Added URL route for keyword autocomplete API endpoint |
| gateway/sds_gateway/users/forms.py | Added keywords field to DatasetInfoForm with cleaning/normalization logic |
| gateway/sds_gateway/templates/users/partials/step_1.html | Added keywords input field to dataset creation form |
| gateway/sds_gateway/templates/users/partials/review_create_dataset.html | Added keywords display section to review step |
| gateway/sds_gateway/templates/users/partials/dataset_details_modal.html | Added keywords section to dataset details modal |
| gateway/sds_gateway/templates/users/group_captures.html | Implemented KeywordAutocomplete JavaScript class for autocomplete functionality |
| gateway/sds_gateway/static/js/deprecated/datasetDetailsModal.js | Added keyword rendering with badge styling to populate dataset modal |
| gateway/sds_gateway/static/js/captureGroupingComponents.js | Added keyword display handling in form handler and dataset review step |
| gateway/sds_gateway/static/js/deprecated/captureGroupingComponents.js | Added keyword display and X-Requested-With header |
| gateway/sds_gateway/static/js/actions/DetailsActionManager.js | Added updateKeywords method to render keywords with badges in dataset details modal |
| gateway/sds_gateway/api_methods/migrations/max_migration.txt | Updated migration marker to reflect new Keyword model migration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
gateway/sds_gateway/static/js/deprecated/datasetDetailsModal.js
Outdated
Show resolved
Hide resolved
lucaspar
requested changes
Dec 3, 2025
modified: gateway/sds_gateway/api_methods/admin.py modified: gateway/sds_gateway/api_methods/migrations/max_migration.txt modified: gateway/sds_gateway/api_methods/models.py modified: gateway/sds_gateway/api_methods/serializers/dataset_serializers.py new file: gateway/sds_gateway/static/js/captureGroupingComponents.js modified: gateway/sds_gateway/static/js/deprecated/captureGroupingComponents.js modified: gateway/sds_gateway/static/js/deprecated/datasetDetailsModal.js modified: gateway/sds_gateway/templates/users/group_captures.html modified: gateway/sds_gateway/templates/users/partials/dataset_details_modal.html modified: gateway/sds_gateway/templates/users/partials/review_create_dataset.html modified: gateway/sds_gateway/users/forms.py modified: gateway/sds_gateway/users/urls.py modified: gateway/sds_gateway/users/views.py
LLKruczek
force-pushed
the
add-dataset-keywords-model
branch
from
35c9ef5 to
350d49d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
SFDS-224